FB4Checklister.cfm

Jeff Peters, February 10, 2005

FB4Checklister is a management utility for Fusebox 4 applications. It reads through the directory tree of the application, and produces a checklist of fuseactions and fusestubs to be coded and tested. The application must be architected at least to the point of having all the circuit.xml files in place; the presence or absence of fuse stubs will not affect FB4Checklister. The result is a printable page for each circuit directory that looks like this:
License: FB4Checklister is free for use and modification, provided modified versions include attribution of the original and are released under the same conditions.

To use FB4Checklister:

1. Place the FB4Checklister.cfm file in your CustomTags directory, or in the top directory of the Fusebox application to be documented.

2. Place the FB4CircuitChecklist.xsl file in the top directory of the application to be documented, or another directory of your choosing. NOTE: If you place this file in a different directory, you MUST use the xslFile attribute to tell FB4Checklister where to find the style sheet.

3. Run FB4Checklister_Call.cfm.

Changing FB4Checklister's Behavior:

You can use three attributes to modify the behavior of FB4Checklister:

thisDir: Controls the beginning directory for the documentation run. This allows you to call FB4Checklister from anywhere. This attribute must be an absolute path to the directory. For example, "c:\InetPub\wwwroot\myApp"

recurse: Controls whether or not FB4Checklister reads subdirectories. Defaults to "yes". If set to "no", FB4Checklister will only document the top directory of the application.

xslFile: Allows the placement of the FB4CircuitChecklist.xsl file in a separate directory. This attribute must be an absolute path to the style sheet. For example, "c:\stylesheets\FB4CircuitChecklist.xsl". NOTE: This attribute also allows you to use your own style sheets with FB4Checklister. You can create any sort of transformation you'd like to have processed
against your application's circuit.xml files.

Examples:

<cf_FB4Checklister>

This is the default call, and results in the documentation of the application in the directory where the calling template is located, with recursion, and using the FB4CircuitChecklist.xsl in the same directory.

<cf_FB4Checklister recurse="no">

This results in the documentation of only the directory where the calling template is located (no recursion), using the FB4CircuitChecklist.xsl in the same directory.

<cf_FB4Checklister xslFile="c:\styleSheets\FB4CircuitsChecklist.xsl">

This results in the documentation of the application in the directory where the calling template is located, with recursion, and using the FB4CircuitChecklist.xsl XSL file in the c:\stylesheets directory.

<cf_FB4Checklister thisDir="c:\sandbox\myNewApp" 
                   xslFile="c:\styleSheets\myBetterStylesheet.xsl">

This results in the documentation of the application in the c:\sandbox\myNewApp directory, using the myBetterStylesheet XSL file in the c:\styleSheets directory. FB4Checklister IS able to document applications that are not in the web tree using this type of call.

NOTE: FB4Checklister requires the CFFILE tag to be enabled, and uses CFMX XML processes.